<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" href="../../../style.css" type="text/css" media="screen">
<link rel="stylesheet" href="../../../print.css" type="text/css" media="print">
<meta content="TextInput,com.jwopitz.controls.TextInput,appearAsLabel,focusOnClear,labelMode,prompt,showClearButton" name="keywords">
<title>com.jwopitz.controls.TextInput</title>
</head>
<body>
<script type="text/javascript" language="javascript" src="../../../asdoc.js"></script><script type="text/javascript" language="javascript" src="../../../cookies.js"></script><script type="text/javascript" language="javascript">
<!--
				asdocTitle = 'TextInput - API Documentation';
				var baseRef = '../../../';
				window.onload = configPage;
			--></script>
<table style="display:none" id="titleTable" cellspacing="0" cellpadding="0" class="titleTable">
<tr>
<td align="left" class="titleTableTitle">API Documentation</td><td align="right" class="titleTableTopNav"><a onclick="loadClassListFrame('../../../all-classes.html')" href="../../../package-summary.html">All&nbsp;Packages</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../../all-classes.html')" href="../../../class-summary.html">All&nbsp;Classes</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../../index-list.html')" href="../../../all-index-A.html">Index</a>&nbsp;|&nbsp;<a href="../../../index.html?com/jwopitz/controls/TextInput.html&amp;com/jwopitz/controls/class-list.html" id="framesLink1">Frames</a><a onclick="parent.location=document.location" href="" style="display:none" id="noFramesLink1">No&nbsp;Frames</a></td><td rowspan="3" align="right" class="titleTableLogo"><img alt="Adobe Logo" title="Adobe Logo" class="logoImage" src="../../../images/logo.jpg"></td>
</tr>
<tr class="titleTableRow2">
<td align="left" id="subTitle" class="titleTableSubTitle">Class&nbsp;TextInput</td><td align="right" id="subNav" class="titleTableSubNav"><a href="#propertySummary">Properties</a>&nbsp;| <a href="#eventSummary">Events</a>&nbsp;| <a href="#styleSummary">Styles</a></td>
</tr>
<tr class="titleTableRow3">
<td colspan="2">&nbsp;</td>
</tr>
</table>
<script type="text/javascript" language="javascript">
<!--
if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("Class TextInput"); titleBar_setSubNav(false,true,true,false,true,false,false,false,false,false,false,false,false,false);}
--></script>
<div class="MainContent">
<table cellspacing="0" cellpadding="0" class="classHeaderTable">
<tr>
<td class="classHeaderTableLabel">Package</td><td><a onclick="javascript:loadClassListFrame('class-list.html')" href="package-detail.html">com.jwopitz.controls</a></td>
</tr>
<tr>
<td class="classHeaderTableLabel">Class</td><td class="classSignature">public class TextInput</td>
</tr>
<tr>
<td class="classHeaderTableLabel">Inheritance</td><td class="inheritanceList">TextInput <img class="inheritArrow" alt="Inheritance" title="Inheritance" src="../../../images/inherit-arrow.gif"> mx.controls.TextInput</td>
</tr>
</table>
<p></p>
   The TextInput control is a single-line text field
   that is optionally editable.
   All text in this control must use the same styling
   unless it is HTML text.
   The TextInput control supports the HTML rendering
   capabilities of the Adobe Flash Player.
     <p>The <code>&lt;jwo_lib:TextInput&gt;</code> tag inherits the attributes
   of its superclass and adds the following attributes:</p>
     <pre>
   &lt;jwo_lib:TextInput
     <b>Properties</b>
     showClearButton="false|true"
     &nbsp;
     <b>Styles</b>
     horizontalGap="5"
     &nbsp;
     <b>Events</b>
     clear="<i>No default</i>"
   /&gt;
   </pre>
     <p></p>
<p>
<span class="classHeaderTableLabel">See also</span>
</p>
<div class="seeAlso">mx.controls.TextInput</div>
<br>
<hr>
</div>
<a name="propertySummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Public Properties</div>
<table id="summaryTableProperty" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Property</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#appearAsLabel">appearAsLabel</a> : Boolean<div class="summaryTableDescription">
   Flag indicating if once the component has lost focus, it should appear as a label, removing the border and clear button.</div>
</td><td class="summaryTableOwnerCol">TextInput</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#focusOnClear">focusOnClear</a> : Boolean<div class="summaryTableDescription">
   Flag indicating if the text field should gain focus after a clear event.</div>
</td><td class="summaryTableOwnerCol">TextInput</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#prompt">prompt</a> : String<div class="summaryTableDescription">
   Indicator string located at the end of the text when <code>labelMode</code> = true.</div>
</td><td class="summaryTableOwnerCol">TextInput</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#showClearButton">showClearButton</a> : Boolean<div class="summaryTableDescription">
   Flag indicating whether or not to show the clear button for the text field.</div>
</td><td class="summaryTableOwnerCol">TextInput</td>
</tr>
</table>
</div>
<a name="protectedPropertySummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Protected Properties</div>
<table id="summaryTableProtectedProperty" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Property</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#labelMode">labelMode</a> : Boolean<div class="summaryTableDescription">
   Flag that tells internal methods if component is in label mode or edit mode.</div>
</td><td class="summaryTableOwnerCol">TextInput</td>
</tr>
</table>
</div>
<a name="eventSummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Events</div>
<table id="summaryTableEvent" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Event</th><th>Summary</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#event:clear">clear</a>
</div>
</td><td class="summaryTableDescription summaryTableCol">
  Triggered when the user clicks the clear button.</td><td class="summaryTableOwnerCol">TextInput</td>
</tr>
</table>
</div>
<a name="styleSummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Styles</div>
<table id="summaryTableStyle" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Style</th><th>Description</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol"><a name="style:disabledSkin"></a>&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<span class="signatureLink">disabledSkin</span>
</div>
</td><td class="summaryTableDescription"><span class="label">Type: </span>Class &nbsp; <span class="label">CSS Inheritance: </span>no<br>
   Name of the class to use as the skin for the background and border
   when the clear button is not selected and is disabled.
      The default value is <code>"/assets/swf/closeButtonSkins.swf#CloseButton_disabledSkin"</code>.</td><td class="summaryTableOwnerCol">TextInput</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol"><a name="style:downSkin"></a>&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<span class="signatureLink">downSkin</span>
</div>
</td><td class="summaryTableDescription"><span class="label">Type: </span>Class &nbsp; <span class="label">CSS Inheritance: </span>no<br>
   Name of the class to use as the skin for the background and border
   when the clear button is not selected and the mouse button is down.
      The default value is <code>"/assets/swf/closeButtonSkins.swf#CloseButton_downSkin"</code>.</td><td class="summaryTableOwnerCol">TextInput</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol"><a name="style:horizontalGap"></a>&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<span class="signatureLink">horizontalGap</span>
</div>
</td><td class="summaryTableDescription"><span class="label">Type: </span>Number &nbsp; <span class="label">Format: </span>Length &nbsp; <span class="label">CSS Inheritance: </span>no<br>
  The horizontal gap between the end of the UITextField and the clear button.
     The default value is <code>5</code>.</td><td class="summaryTableOwnerCol">TextInput</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol"><a name="style:overSkin"></a>&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<span class="signatureLink">overSkin</span>
</div>
</td><td class="summaryTableDescription"><span class="label">Type: </span>Class &nbsp; <span class="label">CSS Inheritance: </span>no<br>
   Name of the class to use as the skin for the background and border
   when the clear button is not selected and the mouse is over the control.
      The default value is <code>"/assets/swf/closeButtonSkins.swf#CloseButton_overSkin"</code>.</td><td class="summaryTableOwnerCol">TextInput</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol"><a name="style:upSkin"></a>&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<span class="signatureLink">upSkin</span>
</div>
</td><td class="summaryTableDescription"><span class="label">Type: </span>Class &nbsp; <span class="label">CSS Inheritance: </span>no<br>
   Name of the class to use as the skin for the background and border
   when the clear button is not selected and the mouse is not over the control.
      The default value is <code>"/assets/swf/closeButtonSkins.swf#CloseButton_upSkin"</code>.</td><td class="summaryTableOwnerCol">TextInput</td>
</tr>
</table>
</div>
<script type="text/javascript" language="javascript">
<!--
showHideInherited();
--></script>
<div class="MainContent">
<a name="propertyDetail"></a>
<div class="detailSectionHeader">Property detail</div>
<a name="appearAsLabel"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">appearAsLabel</td><td class="detailHeaderType">property</td>
</tr>
</table>
<div class="detailBody">
<code>appearAsLabel:Boolean</code>&nbsp;&nbsp;[read-write]<p>
   Flag indicating if once the component has lost focus, it should appear as a label, removing the border and clear button.
   The default value is true.
   </p><p>This property can be used as the source for data binding.</p>
<span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get appearAsLabel():Boolean</code>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function set appearAsLabel(value:Boolean):void</code>
<br>
</div>
<a name="focusOnClear"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">focusOnClear</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>focusOnClear:Boolean</code>&nbsp;&nbsp;[read-write]<p>
   Flag indicating if the text field should gain focus after a clear event.  The default is true.
   </p><span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get focusOnClear():Boolean</code>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function set focusOnClear(value:Boolean):void</code>
<br>
</div>
<a name="labelMode"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">labelMode</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>labelMode:Boolean</code>&nbsp;&nbsp;[read-write]<p>
   Flag that tells internal methods if component is in label mode or edit mode.
   This gets set in the focus event handlers.
   </p><span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;protected function get labelMode():Boolean</code>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;protected function set labelMode(value:Boolean):void</code>
<br>
</div>
<a name="prompt"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">prompt</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>prompt:String</code>&nbsp;&nbsp;[read-write]<p>
   Indicator string located at the end of the text when <code>labelMode</code> = true.
   Default value is " (edit)".
   </p><p>This property can be used as the source for data binding.</p>
<span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get prompt():String</code>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function set prompt(value:String):void</code>
<br>
</div>
<a name="showClearButton"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">showClearButton</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>showClearButton:Boolean</code>&nbsp;&nbsp;[read-write]<p>
   Flag indicating whether or not to show the clear button for the text field.
   </p><p>This property can be used as the source for data binding.</p>
<span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get showClearButton():Boolean</code>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function set showClearButton(value:Boolean):void</code>
<br>
</div>
<div class="detailSectionHeader">Event detail</div>
<a name="event:clear"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">clear</td><td class="detailHeaderType">event&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<span class="label">Event object type: </span><a href=""><code>flash.events.Event</code></a>
<br>
<p></p><p>
  Triggered when the user clicks the clear button.
  </p></div>
<br>
<br>
<hr>
<br>
<p></p>
<center class="copyright"> 
</center>
</div>
</body>
</html>
<!-- -->
